tmf-prepay-balance-management-biz
List Bucket
URL
http://[localhost]:[port]/tmf-api/prepayBalanceManagement/v4/{businessId}/bucketURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | Public identifier to the application o channel | Y |
| client_secret | string | Is a secret known only to the application and the authorization server | Y |
| X-Correlation-ID | string | Correlates HTTP requests between a client and server. | N |
Query Param
| name | type | description | required |
|---|---|---|---|
| logicalResource.id | number | phone number | N |
| partyAccount.id | number | account or subscriber number | N |
| @type | Enum | operation that need to be performed. Ex: ["DetailBalance","RealTimeBalances"] | N |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ] default response
OK - listBucket request processed successfully, response body contains an entity corresponding to the requested resource
PA Response
[
{
"id": "210",
"href": "https://esb-dev.lla.com/tmf-api/prepayBalanceManagement/v4/PA/bucket/66431202?logicalResourceId=66431202",
"isShared": true,
"description": "PROMOCIONAL PSB 210",
"name": "PROMOCIONAL",
"status": "Active",
"logicalResource": [
{
"@type": "MSISDN",
"id": "66431202"
}
],
"partyAccount": {
"id": ""
},
"product": [
{
"id": "66431202"
}
],
"relatedParty": [
{
"id": "",
"@referredType": "ServiceInternalId"
}
],
"@baseType": "BucketBalance",
"@type": "210",
"usageType": "monetary",
"remainingValue": {
"amount": 2.96,
"units": "USD"
},
"remainingValueName": "2.96 USD",
"validFor": {
"startDateTime": "2023-03-17T08:00:00.000-05:00",
"endDateTime": "2023-07-15T08:00:00.000-05:00"
},
"@language": "ENG"
},
{
"id": "1",
"href": "https://esb-dev.lla.com/tmf-api/prepayBalanceManagement/v4/PA/bucket/1?logicalResourceId=66431202",
"isShared": true,
"description": "MINUTOS GRATIS A MAS MOVIL",
"name": "dedicated",
"status": "Inactive",
"logicalResource": [
{
"@type": "MSISDN",
"id": "66431202"
}
],
"partyAccount": {
"id": ""
},
"product": [
{
"id": "1"
}
],
"relatedParty": [
{
"id": "",
"@referredType": "ServiceInternalId"
}
],
"@baseType": "BucketBalance",
"@type": "Bucket",
"usageType": "voice",
"remainingValue": {
"amount": 0,
"units": "min"
},
"remainingValueName": "0 min",
"validFor": {
"endDateTime": ""
},
"@language": "ENG"
}
]BTC Response
[
{
"id": "12423951585",
"href": "https://esb-dev.lla.com/tmf-api/prepayBalanceManagement/v4/BS/bucket/12423951585?logicalResourceId=12423951585",
"isShared": true,
"description": "Core monetary balance",
"name": "Core",
"status": "Active",
"logicalResource": [
{
"@type": "MSISDN",
"id": "12423951585"
}
],
"partyAccount": {
"id": ""
},
"product": [
{
"id": "12423951585"
}
],
"relatedParty": [
{
"id": "",
"@referredType": "ServiceInternalId"
}
],
"@baseType": "BucketBalance",
"@type": "1000",
"usageType": "monetary",
"remainingValue": {
"amount": 0,
"units": "BSD"
},
"remainingValueName": "0 BSD",
"validFor": {
"endDateTime": "2023-07-19T08:00:00.000-04:00"
},
"@language": "ENG"
},
{
"id": "1001",
"href": "https://esb-dev.lla.com/tmf-api/prepayBalanceManagement/v4/BS/bucket/1001?logicalResourceId=12423951585",
"isShared": true,
"description": "Loan",
"name": "Loan",
"status": "Active",
"logicalResource": [
{
"@type": "MSISDN",
"id": "12423951585"
}
],
"partyAccount": {
"id": ""
},
"product": [
{
"id": "1001"
}
],
"relatedParty": [
{
"id": "",
"@referredType": "ServiceInternalId"
}
],
"@baseType": "BucketBalance",
"@type": "Loan",
"usageType": "monetary",
"remainingValue": {
"amount": 0,
"units": "BSD"
},
"remainingValueName": "0 BSD",
"validFor": {
"endDateTime": "9999-12-31T07:00:00.000-05:00"
},
"@language": "ENG"
}
]CWC Responses
GetDetailedBalances
[
{
"name": "Core",
"description": "primaryBalance",
"isShared": true,
"logicalResource": [
{
"@type": "subscriberNumber",
"id": "18765544355"
}
],
"remainingValue": {
"amount": 0.00,
"units": "JMD"
},
"remainingValueName": "primaryBalance",
"usageType": "Core",
"validFor": {
"endDateTime": "2023-03-13T00:00:00.000-05:00"
},
"status": "active",
"@baseType": "BucketBalance",
"@type": "B",
"ratingState": "2",
"@language": "ENG"
},
{
"name": "internet",
"description": "Mobile Internet",
"isShared": true,
"logicalResource": [
{
"@type": "subscriberNumber",
"id": "18765544355"
}
],
"remainingValue": {
"amount": 154.53,
"units": "GB"
},
"remainingValueName": "Mobile Internet",
"usageType": "Internet",
"validFor": {
"endDateTime": "2023-04-18T10:16:40.000-05:00"
},
"status": "active",
"@baseType": "BucketBalance",
"@type": "B",
"ratingState": "2",
"@language": "ENG"
}
]RealTimeBalances
[
{
"id": "1",
"href": "https://esb-dev.lla.com/tmf-api/prepayBalanceManagement/v4/JM/bucket/1?logicalResource.id=18765544355",
"isShared": true,
"name": "CORE",
"description": "Core",
"logicalResource": [
{
"@type": "MSISDN",
"id": "18765544355"
}
],
"partyAccount": {
"id": "32795117"
},
"product": [
{
"id": "16"
}
],
"relatedParty": [
{
"id": "32970253",
"@referredType": "ServiceInternalId"
}
],
"remainingValue": {
"amount": 1932.9,
"units": "JMD"
},
"remainingValueName": "1932.90 JMD",
"usageType": "CURRENCY",
"validFor": {
"endDateTime": "2023-03-13T05:00:00.000-05:00"
},
"status": "active",
"@baseType": "BucketBalance",
"@type": "Real",
"ratingState": "2",
"@language": "ENG"
},
{
"id": "32",
"href": "https://esb-dev.lla.com/tmf-api/prepayBalanceManagement/v4/JM/bucket/32?logicalResource.id=18765544355",
"isShared": true,
"name": "OCS_DATA_BAL_ROAM",
"description": "OCS_DATA_BAL_Roam",
"logicalResource": [
{
"@type": "MSISDN",
"id": "18765544355"
}
],
"partyAccount": {
"id": "32795117"
},
"product": [
{
"id": "16"
}
],
"relatedParty": [
{
"id": "32970253",
"@referredType": "ServiceInternalId"
}
],
"remainingValue": {
"amount": 0,
"units": "OCTET"
},
"remainingValueName": "0 OCTET",
"usageType": "OCTET",
"validFor": {
"endDateTime": "2017-05-15T05:00:00.000-05:00"
},
"status": "active",
"@baseType": "BucketBalance",
"@type": "Real",
"ratingState": "2",
"@language": "ENG"
}
]bucketBalances
[
{
"id": "1",
"href": "https://esb-dev.lla.com/tmf-api/prepayBalanceManagement/v4/bucket/1",
"isShared": true,
"description": "primary balance",
"name": "primary balance",
"status": "active",
"logicalResource": [
{
"@type": "MSISDN",
"id": "18765544355"
}
],
"partyAccount": {
"id": "32795117"
},
"product": [
{
"id": "16"
}
],
"relatedParty": [
{
"id": "32970253",
"@referredType": "ServiceInternalId"
}
],
"@baseType": "BucketBalance",
"@type": "Core",
"usageType": "Currency",
"remainingValue": {
"amount": 1934.9,
"units": "JMD"
},
"remainingValueName": "primary balance",
"validFor": {
"endDateTime": "2023-05-04T00:00:00.000-05:00"
},
"ratingState": "7",
"@language": "ENG"
},
{
"id": "32",
"href": "https://esb-dev.lla.com/tmf-api/prepayBalanceManagement/v4/bucket/32",
"isShared": true,
"description": "Roaming Data",
"name": "Roaming Data",
"status": "suspended",
"logicalResource": [
{
"@type": "MSISDN",
"id": "18765544355"
}
],
"partyAccount": {
"id": "32795117"
},
"product": [
{
"id": "16"
}
],
"relatedParty": [
{
"id": "32970253",
"@referredType": "ServiceInternalId"
}
],
"@baseType": "BucketBalance",
"@type": "Internet",
"usageType": "MB",
"remainingValue": {
"amount": 0,
"units": "MB"
},
"remainingValueName": "Roaming Data",
"validFor": {
"endDateTime": "2017-05-15T00:00:00.000-05:00"
},
"ratingState": "7",
"@language": "ENG"
}
]Note:
CWC:
for CWC-getDetailedBalance, '@type' should be equal to "DetailBalance".
for CWC-getRealTimeBalances, '@type' should be equal to "RealTimeBalances".
else by default, we will get bucketBalance from comverse1.